ODLinkManager

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODLinkManager

Superclasses
ODObject
Subclasses
none

An object of the ODLinkManager class coordinates the creation and maintenance of cross-document links.

Description
The ODLinkManager class uses a platform-dependent implementation of cross-document links, building on facilities provided on each platform. On the Mac OS platform, for example, the link manager uses the Mac OS Edition Manager.
When a document is opened, the session object creates a single link-manager object. All parts of that document share the link manager. Parts do not access the link manager directly; instead, source parts use the ODLinkSource class (page 371) and destination parts use the ODLink class (page 348).
The document shell or a container application can obtain a reference to the link manager by calling the session object's GetLinkManager method (page 608). The link manager's methods are called by link objects, draft objects, and document shells; they are not used by parts.
When a cross-document link is established, the link-manager object of the destination draft communicates with the link-manager object of the source draft to create the link. Neither the source nor destination parts know that the link is cross-document; the source draft and the destination draft each maintain a link-source object and a link object, and the parts involved communicate only with the link-source objects and link objects of their own drafts.
When a draft is opened, the link-manager object ensures that the link destinations from other documents have the opportunity to update to the latest content. It also maintains a list of cross-document link sources that should be updated when the draft is saved.
On the Mac OS platform, the link-manager object provides the coordination of Edition Manager section IDs with the OpenDoc shell or with container applications that support Publish and Subscribe. A container application can reserve section IDs already in use by calling the ReserveSectionID method (page 368). A container application can get a new section ID that is unique for the life of the document by calling the NewSectionID method (page 368).
For more information related to links, see the descriptions of the classes ODLink (page 348), ODLinkSource (page 371), and ODLinkSpec (page 390). For more information about linking, see the chapter on data transfer in the OpenDoc Programmer's Guide for the MacOS.

Methods
This section presents summary descriptions of the ODLinkManager methods, followed by detailed descriptions in alphabetical order. Methods marked [D] are called only by the document shell or container applications. Methods marked [M] are specific to the Mac OS platform.

AnyLinkImported [D]
Returns a Boolean value that indicates whether one or more links to the source in other documents have been updated automatically since the specified draft was last saved.
UnsavedExportedLinks [D]
Returns a Boolean value that indicates whether any cross-document links have been established since the last time the specified draft was saved.
DraftClosing [D]
Notifies this link manager that the specified draft is about to be closed.
DraftOpened [D]
Notifies this link manager that the specified draft has been opened.
DraftSaved [D]
Notifies this link manager that the specified draft has been saved.
NewSectionID [D] [M]
Returns a new section ID for the document of the specified draft.
ReserveSectionID [D] [M]
Reserves a section ID for the lifetime of the document of the specified draft.

Methods
AnyLinkImported
DraftClosing
DraftOpened
DraftSaved
NewSectionID
ReserveSectionID
UnsavedExportedLinks